/*
 * (C) 2009, Elephant Seven Hamburg Gmbh, 
 * Author: Detlev Wiese
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not 
 * use this file except in compliance with the License. You may obtain a copy 
 * of the License at
 *  
 *     http://www.apache.org/licenses/LICENSE-2.0 
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.se and its accompanying notice file is
 * included with the distribution. 
 */ 
package com.e7.streams;

/**
 * A stream class which provides an infinite count of always the 
 * same constant element.
 * @param <E> The type of the stream and the element
 */
public class ConstantStream<E> extends AbstractStream<E>{

	private final E constant; 
	
	/**
	 * Create an instance!
	 * @param constant The constant element of the stream
	 */
	public ConstantStream(E constant) { 
		this.constant = constant;
	}
	
	/**
	 * {@inheritDoc}
	 * <p>Note: a {@code ConstantStream}-instance will always return 
	 * {@code true}.</p>
	 */
	public boolean hasNext() {
		return true;
	}

	/**
	 * {@inheritDoc}
	 * <p>Note: a {@code ConstantStream}-instance will always return 
	 * its constant element.</p>
	 */
	public E next() {
		return constant;
	}
}
